home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #14 / Monster Media No. 14 (April 1996) (Monster Media, Inc.).ISO / os2 / pmdiff40.zip / PMDIFF.HLP (.txt) < prev    next >
OS/2 Help File  |  1996-01-28  |  18KB  |  447 lines

  1.  
  2. ΓòÉΓòÉΓòÉ 1. Disclaimer ΓòÉΓòÉΓòÉ
  3.  
  4. This product is supplied with no warranty, either expressed or implied. The 
  5. Authors (Daniel J Neades and Jason R Shannon) will not accept responsibility 
  6. for any adverse consequences that may arise from the use or misuse of PMdiff or 
  7. its associated program and data files. Such adverse consequences include, but 
  8. are not limited to, loss of profit, and loss of data. 
  9.  
  10. The Authors specifically disclaim all warranties, expressed or implied, 
  11. including but not limited to, any implied warranty of merchantability or 
  12. fitness for a particular purpose. 
  13.  
  14.  
  15. ΓòÉΓòÉΓòÉ 2. Copyright ΓòÉΓòÉΓòÉ
  16.  
  17. PMdiff is Copyright 1993-1996 Daniel J Neades and Jason R Shannon. 
  18.  
  19. PMdiff exists in evaluation and licensed versions. 
  20.  
  21. Evaluation copies of PMdiff are supplied for evaluation only. You may 
  22. distribute them freely, but they are not to be used commercially. After 21 days 
  23. of evaluation, you must cease using PMdiff unless you register it. 
  24.  
  25. Licensed copies of PMdiff may be used commerically, but not freely distributed. 
  26. Each licensed copy may be used by only one person at any particular time. 
  27.  
  28. The copyright of PMdiff is held by the authors, Daniel J Neades and Jason R 
  29. Shannon. 
  30.  
  31.  
  32. ΓòÉΓòÉΓòÉ 3. Licensing PMdiff ΓòÉΓòÉΓòÉ
  33.  
  34. PMdiff is useful to almost everyone who uses IBM OS/2 and Microsoft Windows NT. 
  35. It is particularly attractive to software engineers who often wish to compare 
  36. different versions of source code files. 
  37.  
  38. If you sell software development tools, you may wish to consider bundling 
  39. PMdiff with your product to give it the competitive edge. 
  40.  
  41. You can ship the evaluation version of PMdiff with your products free of charge 
  42. (but please contact us to obtain permission first). 
  43.  
  44. The licensed version of PMdiff may be shipped with your products under 
  45. negotiable terms. To contact us, see Contacting the Authors. 
  46.  
  47. Alternatively, see How to Register if you simply wish to continue using PMdiff. 
  48.  
  49.  
  50. ΓòÉΓòÉΓòÉ 4. How to Register and receive support ΓòÉΓòÉΓòÉ
  51.  
  52. PMdiff version 4.0 is shareware. This means that you can use the program for a 
  53. limited time (21 days) before you decide whether you want to keep it. If you 
  54. want to continue using PMdiff after that time you are expected to register it. 
  55.  
  56. The licensed version of PMdiff (which will be sent to you when you register) 
  57. allows you to save your preferences between sessions and save merged files. 
  58. Otherwise, it is identical to (or better than) the evaluation version. 
  59.  
  60. Once you have registered, technical support is available from the authors via 
  61. e-mail (see Contacting the Authors). Voice telephone support is not provided. 
  62.  
  63. PMdiff can be registered from BMT Micro. BMT Micro accepts Visa, Mastercard, 
  64. Discover, American Express, money order, cashiers checks and personal checks. 
  65. DM and British currency is also accepted via registered mail. See the file 
  66. orderfrm.txt supplied with PMdiff for details. 
  67.  
  68. PMdiff 4.0 is inexpensive to register: 
  69.  
  70.     US$30 to register a new copy 
  71.     US$15 to upgrade a registered copy of PMdiff 3.1 
  72.     US$20 to upgrade a registered copy of PMdiff 2.7 
  73.  
  74.  Note 
  75.  PMdiff 4.0 is also available as a native 32 bit Microsoft Windows NT/Windows 
  76.  95 application. 
  77.  
  78.  
  79. ΓòÉΓòÉΓòÉ 5. Contacting the Authors ΓòÉΓòÉΓòÉ
  80.  
  81. You may contact the authors via Internet email for technical support or to 
  82. initiate licensing negotiations. Send mail to pmdiff@arac.demon.co.uk. 
  83.  
  84.  
  85. ΓòÉΓòÉΓòÉ 6. General Help ΓòÉΓòÉΓòÉ
  86.  
  87. PMdiff presents the differences between two files in a graphical format, 
  88. allowing you to browse through the files. Lines are drawn between corresponding 
  89. changes in the two files. 
  90.  
  91. Choose one of the following hyperlinks for help about performing specific 
  92. actions in PMdiff. 
  93.  
  94.     How to register PMdiff and receive support 
  95.     How to license PMdiff 
  96.  
  97.     Loading files 
  98.     Scrolling files 
  99.     Merging files 
  100.     Moving the lines window 
  101.     Changing fonts 
  102.     Changing colours 
  103.     Using the keyboard 
  104.  
  105.  
  106. ΓòÉΓòÉΓòÉ 7. Actions ΓòÉΓòÉΓòÉ
  107.  
  108. Select an appropriate topic for information about how to perform a particular 
  109. task. 
  110.  
  111.  
  112. ΓòÉΓòÉΓòÉ 7.1. Loading Files ΓòÉΓòÉΓòÉ
  113.  
  114. Files can be loaded into PMdiff in one of three ways: 
  115.  
  116.     By specifying them on the command line when you start PMdiff. 
  117.  
  118.     By using the File Open dialog. 
  119.  
  120.     By using drag and drop to copy the file(s) from a Workplace Shell folder to 
  121.     either of the file display windows, or onto a PMdiff program object on the 
  122.     desktop. 
  123.  
  124.  
  125. ΓòÉΓòÉΓòÉ 7.2. Scrolling Files ΓòÉΓòÉΓòÉ
  126.  
  127. You can scroll files vertically and horizontally using the scroll bars. 
  128. Scrolling one file may result in the other also being scrolled, depending on 
  129. the settings in the Linking page of the Preferences notebook. 
  130.  
  131. Moving the scroll bars with mouse button 2 instead of mouse button 1 will 
  132. result in any linking being delayed until button 2 is released. 
  133.  
  134. There are two double-arrowed buttons beneath each vertical scroll bar. These 
  135. allow you to jump to the next and previous differences quickly. 
  136.  
  137. Note 
  138. The evaluation version of PMdiff pops up a dialog box every time you move to 
  139. the next or previous difference. See How to Register for details on how to 
  140. register PMdiff and receive a version that does not have this annoying feature. 
  141.  
  142.  
  143. ΓòÉΓòÉΓòÉ 7.3. Merging files ΓòÉΓòÉΓòÉ
  144.  
  145. If you enable the file merge facility (see options) then you can select the 
  146. text that you want from both files and save a file containing it. A raised 
  147. vertical bar is drawn in the central lines window next to the text that will be 
  148. saved. 
  149.  
  150. You can select or deselect text by clicking on it with mouse button 1. The 
  151. raised vertical bar in the central lines window adjacent to the text will 
  152. appear or disappear to show whether the text is selected. 
  153.  
  154. When you have chose the changes that you wish to keep, select Save merged file 
  155. from the File menu, or from the pop-up menus. If you select Save merged file 
  156. from the pop-up menu for the left file, the save filename will default to the 
  157. name of the left file. Using the right file pop-up menu will use the right 
  158. filename as the default save name. Of course, you can enter a different 
  159. filename if wish. 
  160.  
  161. Note 
  162. The evaluation version of PMdiff does not allow you to save merged file 
  163. changes. See How to Register for details on how to register PMdiff and receive 
  164. a version with save enabled. 
  165.  
  166.  
  167. ΓòÉΓòÉΓòÉ 7.4. Moving the Lines Window ΓòÉΓòÉΓòÉ
  168.  
  169. You can change the relative widths of the two file display windows. To do this, 
  170. move the pointer over the double-headed arrow above the lines window, click and 
  171. hold down mouse button 2, and drag the window to the left or right. Release the 
  172. button when you have moved the lines window to the desired place. 
  173.  
  174. To re-centre the lines window, double-click either mouse button on the double 
  175. headed arrow. 
  176.  
  177. See the help for the Lines page of the Preferences notebook for information on 
  178. how to change the width of the central lines window. 
  179.  
  180.  
  181. ΓòÉΓòÉΓòÉ 7.5. Colours ΓòÉΓòÉΓòÉ
  182.  
  183. You can change the colours used by PMdiff by dragging colours from the OS/2 
  184. Colour Palette and dropping on PMdiff. It is possible to change the foreground 
  185. and background colours for each of the four different text types. Simply drop 
  186. the desired colour on the type of text that you wish to change. The colour of 
  187. the linking lines can also be changed by dropping a colour onto the central 
  188. lines window. 
  189.  
  190.  
  191. ΓòÉΓòÉΓòÉ 7.6. Fonts ΓòÉΓòÉΓòÉ
  192.  
  193. You can change the font used to display files by dragging from the OS/2 Font 
  194. Palette and dropping on either of the file windows. You can also change the 
  195. font used in the status lines above the file windows. 
  196.  
  197.  
  198. ΓòÉΓòÉΓòÉ 7.7. Shortcuts ΓòÉΓòÉΓòÉ
  199.  
  200. Most menu items have short-cut keys, which are described next to the menu item 
  201. which they emulate. In addition, there is a pop-up menu available by pressing 
  202. mouse button 2 when the pointer is over either of the file display windows. 
  203.  
  204. PMdiff supports extensive use of the keyboard for moving around files. The Page 
  205. Up, Page Down and the up and down arrow keys move the file display up and down. 
  206. Holding down the Ctrl key with the up and down arrows moves between the next 
  207. and previous differences. 
  208.  
  209. Note 
  210. Keyboard actions affect the last file display that was clicked upon using mouse 
  211. button 1. Alternatively, you can use the Tab key to switch active windows. If 
  212. you have pressed Tab, then the file with input focus is shown with a dotted 
  213. border. This input focus emphasis is not drawn by default (and is removed if 
  214. you click on either file with the mouse) so that the display remains as 
  215. uncluttered as possible. 
  216.  
  217.  
  218. ΓòÉΓòÉΓòÉ 8. Extended Lines ΓòÉΓòÉΓòÉ
  219.  
  220. Selecting Extend lines from the popup menu toggles extended lines on or off. 
  221. The current state is indicated by the presence or absence of a checkmark next 
  222. to the menu item. This option mirrors the checkbox on the Lines page of the 
  223. Preferences notebook. 
  224.  
  225.  
  226. ΓòÉΓòÉΓòÉ 9. Expand Tabs ΓòÉΓòÉΓòÉ
  227.  
  228. Selecting Expand tabs from the popup menu toggles tab expansion on or off. The 
  229. current state is indicated by the presence or absence of a checkmark next to 
  230. the menu item. This option mirrors the checkbox on the Options page of the 
  231. Preferences notebook. 
  232.  
  233. Note that selecting this menu item will changes in tab expansion to take 
  234. immediate effect, unlike checking or unchecking the option on the Options 
  235. notebook page. 
  236.  
  237.  
  238. ΓòÉΓòÉΓòÉ 10. File Menu ΓòÉΓòÉΓòÉ
  239.  
  240. The File menu allows you to load files into PMdiff, configure PMdiff 
  241. preferences and perform other miscellaneous operations. The following items are 
  242. available: 
  243.  
  244.     Open left 
  245.     Open right 
  246.     Save merged files 
  247.     Swap 
  248.     Rediff 
  249.     Preferences 
  250.     Exit 
  251.  
  252.  
  253. ΓòÉΓòÉΓòÉ 10.1. File->Open left and File->Open right ΓòÉΓòÉΓòÉ
  254.  
  255. Selecting Open left or Open right from the File menu brings up a standard file 
  256. dialog. From this you can select a file to load into either the left or right 
  257. PMdiff file display windows. 
  258.  
  259.  
  260. ΓòÉΓòÉΓòÉ 10.2. File->Save merged files ΓòÉΓòÉΓòÉ
  261.  
  262. If file merging is enabled, selecting Saved merged files from the File menu 
  263. brings up a standard file save dialog. From this you can select the name of the 
  264. file which is to contain the merged changes of the two open files. 
  265.  
  266.  
  267. ΓòÉΓòÉΓòÉ 10.3. File->Swap ΓòÉΓòÉΓòÉ
  268.  
  269. Selecting Swap from the File menu swaps the contents of the two PMdiff file 
  270. display windows. 
  271.  
  272. You may only select Swap if you have loaded at least one file into PMdiff and 
  273. if PMdiff is not currently working out the differences between two files. 
  274.  
  275.  
  276. ΓòÉΓòÉΓòÉ 10.4. File->Rediff ΓòÉΓòÉΓòÉ
  277.  
  278. Selecting this menu item forces PMdiff to reload and rediff the currently 
  279. displayed files. This is useful if you have modified one or other of the files 
  280. since they were first loaded. 
  281.  
  282. Note that it is not possible to select Rediff if PMdiff is already in the 
  283. process of working out the differences between two files. 
  284.  
  285.  
  286. ΓòÉΓòÉΓòÉ 10.5. File->Preferences ΓòÉΓòÉΓòÉ
  287.  
  288. PMdiff allows many options to be configured to suit your preferences. Selecting 
  289. Preferences brings up the PMdiff Preferences notebook. This has four pages: 
  290.  
  291.     Linking 
  292.     Styles 
  293.     Lines 
  294.     Options 
  295.  
  296.  
  297. ΓòÉΓòÉΓòÉ 10.6. File->Exit ΓòÉΓòÉΓòÉ
  298.  
  299. Selecting Exit ends your current PMdiff session. 
  300.  
  301.  
  302. ΓòÉΓòÉΓòÉ 11. Help Menu ΓòÉΓòÉΓòÉ
  303.  
  304. The Help menu allows you to access help about various aspects of PMdiff. The 
  305. following items are available: 
  306.  
  307.     Help index 
  308.     General help 
  309.     Using help 
  310.     Product information 
  311.  
  312.  
  313. ΓòÉΓòÉΓòÉ 11.1. Help->Help index ΓòÉΓòÉΓòÉ
  314.  
  315. Selecting the Help index menu item gives you an index of all PMdiff help 
  316. topics. 
  317.  
  318.  
  319. ΓòÉΓòÉΓòÉ 11.2. Help->General help ΓòÉΓòÉΓòÉ
  320.  
  321. Selecting General help gives you an overview of PMdiff. 
  322.  
  323.  
  324. ΓòÉΓòÉΓòÉ 11.3. Help->Using help ΓòÉΓòÉΓòÉ
  325.  
  326. Select Using help if you are unfamiliar with the OS/2 on-line help system. 
  327.  
  328.  
  329. ΓòÉΓòÉΓòÉ 11.4. Help->Product information ΓòÉΓòÉΓòÉ
  330.  
  331. Product information brings up a dialog box containing information on PMdiff. Of 
  332. particular note is the version number. 
  333.  
  334. Push the OK button to dismiss the dialog. 
  335.  
  336.  
  337. ΓòÉΓòÉΓòÉ 12. Preferences notebook ΓòÉΓòÉΓòÉ
  338.  
  339. The Preferences notebook allows you to configure PMdiff to suit your 
  340. requirements. The notebook consists of four pages; simply click on a page tab 
  341. in order to turn to that page. Any changes that you make using the notebook 
  342. take immediate effect. 
  343.  
  344. For help on individual pages select a hyperlink from the list below: 
  345.  
  346.     Linking 
  347.     Styles 
  348.     Lines 
  349.     Options 
  350.  
  351.  
  352. ΓòÉΓòÉΓòÉ 12.1. Preferences notebook: Linking Page ΓòÉΓòÉΓòÉ
  353.  
  354. This page allows you to change the way in which PMdiff links the two file 
  355. display windows together. 
  356.  
  357. Vertical Linking 
  358. By default, when you vertically scroll one file, PMdiff automatically scrolls 
  359. the other so that correspondances between the two files are vertically aligned 
  360. in the centre of the file display windows. This is Centre vertical linking. 
  361.  
  362. As an alternative to Centre linking, you can tell PMdiff to align 
  363. correspondances at the top or bottom of the file display windows, depending on 
  364. the direction of movement. To do this, select Top/Bottom linking. If you scroll 
  365. upward (toward the top of the file) then correspondances are aligned at the top 
  366. of the windows. Scrolling downward aligns correspondances at the bottom of the 
  367. file display windows. 
  368.  
  369. Finally, you may disable vertical linking completely by selecting the Unlinked 
  370. option. Note that you can temporarily achieve the same effect by using mouse 
  371. button 2 to move the scroll bar instead of button 1. Linking will then not take 
  372. place until you release the button. 
  373.  
  374. Horizontal Linking 
  375. Horizontal linking can be either on or off. If it is on, then scrolling one 
  376. file horizontally will result in the other also being scrolled. Otherwise, the 
  377. two files are not horizontally linked. 
  378.  
  379. Pushing the Default button resets horizontal and vertical linking to the PMdiff 
  380. defaults. 
  381.  
  382.  
  383. ΓòÉΓòÉΓòÉ 12.2. Preferences notebook: Styles Page ΓòÉΓòÉΓòÉ
  384.  
  385. This notebook page allows you to configure your choice of styles for the four 
  386. different types of text that PMdiff displays: Unchanged, Changed, Inserted and 
  387. Deleted. 
  388.  
  389. Unchanged text is that which is the same in both of the files being compared. 
  390. Changed text is text which has been replaced in the transition from one file to 
  391. another. Inserted text is that which is not present in the left file, but has 
  392. been inserted into the one on the right. Deleted text is present in the left 
  393. file, but not in the right. 
  394.  
  395. For each of the four text types you may choose any combination of Bold, Italic, 
  396. Underscore and Strikeout styles. 
  397.  
  398. Pushing the Default button resets all character styles to the PMdiff defaults. 
  399.  
  400. Clicking on Reset colours will undo any changes that you have made to the 
  401. PMdiff colour scheme. For slow computers, it is recommended that do not change 
  402. the background colours since this slows down the display. 
  403.  
  404. See also 
  405.     Changing fonts 
  406.     Changing colours 
  407.  
  408.  
  409. ΓòÉΓòÉΓòÉ 12.3. Preferences notebook: Lines Page ΓòÉΓòÉΓòÉ
  410.  
  411. Using this notebook page you can alter the width (in pixels) of the central 
  412. lines section (in which the lines showing correspondances between the left and 
  413. right files are drawn). 
  414.  
  415. In addition, you can optionally extend the lines in the lines section over the 
  416. text in the file display window. 
  417.  
  418.  
  419. ΓòÉΓòÉΓòÉ 12.4. Preferences notebook: Options Page ΓòÉΓòÉΓòÉ
  420.  
  421. The White space section tells PMdiff how to treat white space when comparing 
  422. files. White space can be treated as significant, ignored at the start of lines 
  423. or ignored totally. 
  424.  
  425. The Miscellaneous section allows you to: 
  426.     select whether CR and LF characters are explicitly shown 
  427.     enable or disable the display of line numbers 
  428.     enable the file merge feature. 
  429.  
  430.  The Tabs section on this notebook page allows you to expand tabs to a given 
  431.  number of spaces. Note that this option is only really useful if you have 
  432.  instructed PMdiff to use a mono-spaced font. 
  433.  
  434.  Save on exit allows you to choose whether to save your PMdiff preferences when 
  435.  you leave PMdiff. It also allows you to store the window size and position on 
  436.  exit. 
  437.  
  438.  Note 
  439.  The evaluation version of PMdiff does not allow you to save either the 
  440.  preferences or window position. See How to Register for details on how to 
  441.  register PMdiff and receive a version with save enabled. 
  442.  
  443.  
  444. ΓòÉΓòÉΓòÉ 13. File Open Dialog ΓòÉΓòÉΓòÉ
  445.  
  446. The file dialog allows you to load a file into PMdiff. It works in exactly the 
  447. same way as all other OS/2 standard file dialogs.